home *** CD-ROM | disk | FTP | other *** search
/ Merciful 5 / Merciful - Disc 5.iso / software / h / hypertextdatav40.12cr.lha / HTDS / Docs / directory.hguide < prev    next >
Encoding:
Amiga HyperGuide  |  1997-04-05  |  5.4 KB  |  134 lines

  1. @hyperguide directory.hguide
  2. @$VER: directory.hguide 40.3 (22.08.96)
  3. @macro m_prg "@{b}Directory DataType@{ub}"
  4. @include htds.hgm
  5.  
  6. @node main "Directory DataType Documentation"
  7. @toc HTDS.hguide/main
  8. @prev html.hguide/main
  9. @next productinfo.hguide/main
  10.  
  11. @{jcenter}@{m_title}@{m_copyright}@{m_welcome}@{jleft}
  12.  
  13. @{settabs 30}
  14. @{m_sec Menu}
  15. @{m_menuitem}@{" Configuration " link Configuration                }@{m_menuinfo "Adapt to your needs"}
  16. @{m_menuitem}@{" Formats "       link Formats                      }@{m_menuinfo "Formatting a entry"}
  17. @{m_menuitem}@{" Attributes "    link hypertext.hguide/CommonAttrs }@{m_menuinfo "Using HyperGuide attributes"}
  18. @{m_menuitem}@{" Usage "         link Usage                        }@{m_menuinfo "How to use the dirdt with MultiView"}
  19. @{m_menuitem}@{" Base Datatype " link hypertext.hguide/main        }@{m_menuinfo "The HyperText Datatype"}
  20. @{line}
  21. @{m_menuitem}@{" Copyright "     link HTDS.hguide/Copyright        }@{m_menuinfo "legal stuff"}
  22. @{m_menuitem}@{" Author "        link SR.hguide/Addresses          }@{m_menuinfo "how to contact me"}
  23. @{m_menuitem}@{" Registration "  link HTDS.hguide/Registration     }@{m_menuinfo "It's Shareware !!!"}
  24. @{m_endsec}
  25.  
  26. @endnode
  27. @node Configuration "Directory DataType/Configuration"
  28.  
  29. @{m_sec "Configuration"}
  30. As the recommended standard for datatypes, the preference file for the
  31. directory.datatype is called @{m_file directory.prefs} and is searched first in
  32. the @{m_file PROGDIR:Prefs/DataTypes} and then in @{m_file Env:DataTypes} directory.
  33. The following options are currently available using ReadArgs() argument parsing :
  34.  
  35.  
  36. @{definition}
  37. FORMAT/K,SHOWTYPE/K,SORTBY/K,HIDEINFO/S,HIDEDOT/S,PARENTENTRY/S,USEDTLIB/S,ROOTENTRY/S :
  38.  
  39. @{defterm}FORMAT
  40. @{defdata}This string specifies the directory entry format template.
  41. See @{" Entry Formats " link Formats} and @{" Common Attributes " link hypertext.hguide/CommonAttrs}
  42. for detailed information.
  43.  
  44. @{defterm}SHOWTYPE
  45. @{defdata}Sets the type, how the dirctory should be shown.
  46. The following modes are available :
  47. @{definition}
  48. @{m_defitem "DIRSFIRST"}directories are listed before any files
  49. @{m_defitem "DIRSLAST" }directories are listed after any files
  50. @{m_defitem "MIXED"    }directories and files are mixed.
  51. @{m_defitem "ICONS"    }the directory is shown by icons of each directory/file.
  52. (Not implemented yet)
  53. @{enddefinition}
  54.  
  55. @{defterm}SORTBY
  56. @{defdata}Sets the sorting criteria. Following modes are available :
  57. @{definition}
  58. @{m_defitem "NAME"  }sorts directory by name
  59. @{m_defitem "LENGTH"}sorts directory by the length of the files
  60. @{m_defitem "DATE"  }sorts directory by the date of the files
  61. @{enddefinition}
  62.  
  63. @{defterm}HIDEINFO
  64. @{defdata}Indicates, that icon @{m_file .info} files should not be included
  65. in the directory list.
  66.  
  67. @{defterm}HIDEDOT
  68. @{defdata}Indiactes, that file beginning with a dot should not be included
  69. in the directory list.@{line}
  70. For example the workbench @{m_file .backdrop} files are excluded.
  71.  
  72. @{defterm}PARENTENTRY
  73. @{defdata}Indicates, that for each directory a parent directory entry
  74. should be included at the head of the listing.
  75.  
  76. @{defterm}USEDTLIB
  77. @{defdata}Indicates, that the datatypes.library should be used to determine
  78. the type of the file, which will be shown with the @{m_sample %z} format command.
  79. If this isn't specifies only normal file types are shown like @{m_sample file},
  80. @{m_sample dir} etc.
  81.  
  82. @{defterm}ROOTENTRY
  83. @{defdata}Indicates, that for each directory a root `directory' entry
  84. should be included at the head of the listing. This root `directory'
  85. is a list of all currently available volumes and assigns. You need for
  86. this my new Root: handler. See @{http_addr "http://home.pages.de/~Ruppert/amiga/"}.
  87. @{enddefinition}
  88. @{m_endsec}
  89. @endnode
  90. @node Formats "Directory DataType/Entry Formats"
  91.  
  92. @{m_sec "Entry Formats"}
  93. Each directory entry is layouted using a entry format template. This
  94. template can consists out of HyperGuide style attributes and the
  95. following '%' format options. You can set this template in the
  96. @{"preference" link Configuration} file for the directory.datatype. For some
  97. of the format option you can specify the width in characters. To do so just
  98. include a number between the '%' and the character. For example @{m_sample "%30s"}. This
  99. is indicated with a @{m_sample [w]} string.
  100.  
  101. @{definition}
  102. @{m_defitem "%a"   }protection bits
  103. @{m_defitem "%[w]c"}comment. Default width is 20.
  104. @{m_defitem "%[w]d"}date. Default width is 9.
  105. @{m_defitem "%e"   }suffix
  106. @{m_defitem "%f"   }full filepath (not yet implemented)
  107. @{m_defitem "%[w]g"}group id. Default width is 8.
  108. @{m_defitem "%[w]l"}file length. Default width is 8.
  109. @{m_defitem "%m"   }basename
  110. @{m_defitem "%n"   }filename (not yet implemented)
  111. @{m_defitem "%p"   }path (not yet implemented)
  112. @{m_defitem "%[w]s"}filename and link to the file. Default width is 20.
  113. @{m_defitem "%[w]t"}time. Default width is 9.
  114. @{m_defitem "%[w]u"}owner id. Default width is 8.
  115. @{m_defitem "%[w]z"}type of the entry (DataTypes/FileType). Default width is 8.
  116. @{enddefinition}
  117. @{m_endsec}
  118. @endnode
  119. @node Usage "Directory DataType/Usage"
  120.  
  121. @{m_sec "Usage"}
  122. MultiView opens normally a file requester, if you specify a directory. To avoid
  123. this and to open a directory with MultiView you can specify the WINDOW option.
  124. This causes MultiView to open the window directly and the directory is displayed
  125. using the directory.datatype.
  126.  
  127. For example :@{line}
  128.  
  129. @{code}MultiView "" WINDOW :@{body} opens a window with the current directory.
  130. @{m_endsec}
  131. @endnode
  132.  
  133.  
  134.